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 externalDocs: description: Amazon Web Services documentation url: https://docs.aws.amazon.com/apprunner/ 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) x-hasEquivalentPaths: true paths: /#X-Amz-Target=AppRunner.AssociateCustomDomain: post: operationId: AssociateCustomDomain description:Associate your own domain name with the App Runner subdomain URL of your App Runner service.
After you call AssociateCustomDomain and receive a successful
response, use the information in the CustomDomain record that's returned to add CNAME records to your Domain Name System (DNS). For each mapped domain name, add a mapping to the target
App Runner subdomain and one or more certificate validation records. App Runner then performs DNS validation to verify that you own or control the domain name that you associated. App Runner
tracks domain validity in a certificate stored in AWS Certificate Manager (ACM).
Create an App Runner automatic scaling configuration resource. App Runner requires this resource when you create or update App Runner services and you require non-default auto scaling settings. You can share an auto scaling configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using the same
AutoScalingConfigurationName. The call returns incremental AutoScalingConfigurationRevision values. When you create a service and configure an auto scaling
configuration resource, the service uses the latest active revision of the auto scaling configuration by default. You can optionally configure the service to use a specific revision.
Configure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the Amazon Web Services Region. The tradeoff is a higher minimal
cost.
Configure a lower MaxSize to control your cost. The tradeoff is lower responsiveness during peak demand.
Create an App Runner connection resource. App Runner requires a connection resource when you create App Runner services that access private repositories from certain third-party providers. You can share a connection across multiple services.
A connection resource is needed to access GitHub repositories. GitHub requires a user interface approval process through the App Runner console before you can use the connection.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/CreateConnectionResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '482': description: ServiceQuotaExceededException content: application/json: schema: $ref: '#/components/schemas/ServiceQuotaExceededException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateConnectionRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.CreateConnection 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' /#X-Amz-Target=AppRunner.CreateObservabilityConfiguration: post: operationId: CreateObservabilityConfiguration description:Create an App Runner observability configuration resource. App Runner requires this resource when you create or update App Runner services and you want to enable non-default observability features. You can share an observability configuration across multiple services.
Create multiple revisions of a configuration by calling this action multiple times using
the same ObservabilityConfigurationName. The call returns incremental ObservabilityConfigurationRevision values. When you create a service and configure an
observability configuration resource, the service uses the latest active revision of the observability configuration by default. You can optionally configure the service to use a specific
revision.
The observability configuration resource is designed to configure multiple features (currently one feature, tracing). This action takes optional parameters that describe the
configuration of these features (currently one parameter, TraceConfiguration). If you don't specify a feature parameter, App Runner doesn't enable the feature.
Create an App Runner service. After the service is created, the action also automatically starts a deployment.
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.
DeleteConnection
action fails.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConnectionResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'482':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteConnectionRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AppRunner.DeleteConnection
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'
/#X-Amz-Target=AppRunner.DeleteObservabilityConfiguration:
post:
operationId: DeleteObservabilityConfiguration
description: Delete an App Runner observability configuration resource. You can delete a specific revision or the latest active revision. You can't delete a configuration that's used by one or
more App Runner services.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteObservabilityConfigurationResponse'
'480':
description: InvalidRequestException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidRequestException'
'481':
description: InternalServiceErrorException
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServiceErrorException'
'482':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/DeleteObservabilityConfigurationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- AppRunner.DeleteObservabilityConfiguration
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'
/#X-Amz-Target=AppRunner.DeleteService:
post:
operationId: DeleteService
description: Delete an App Runner service.
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.
Make sure that you don't have any active VPCIngressConnections associated with the service you want to delete.
Delete an App Runner VPC Ingress Connection resource that's associated with an App Runner service. The VPC Ingress Connection must be in one of the following states to be deleted:
AVAILABLE
FAILED_CREATION
FAILED_UPDATE
FAILED_DELETION
Disassociate a custom domain name from an App Runner service.
Certificates tracking domain validity are associated with a custom domain and are stored in AWS Certificate Manager (ACM). These certificates aren't deleted as part of this action. App Runner delays certificate deletion for 30 days after a domain is disassociated from your service.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/DisassociateCustomDomainResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '483': description: InvalidStateException content: application/json: schema: $ref: '#/components/schemas/InvalidStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DisassociateCustomDomainRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.DisassociateCustomDomain 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' /#X-Amz-Target=AppRunner.ListAutoScalingConfigurations: post: operationId: ListAutoScalingConfigurations description:Returns a list of active App Runner automatic scaling configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular
configuration revision, call and provide one of the ARNs returned by ListAutoScalingConfigurations.
Returns a list of active App Runner observability configurations in your Amazon Web Services account. You can query the revisions for a specific configuration name or the revisions for all active configurations in your account. You can optionally query only the latest revision of each requested name.
To retrieve a full description of a particular
configuration revision, call and provide one of the ARNs returned by ListObservabilityConfigurations.
Return a list of operations that occurred on an App Runner service.
The resulting list of OperationSummary objects is sorted in reverse chronological order. The first object on the list represents the last started operation.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListOperationsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '482': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListOperationsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.ListOperations 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' /#X-Amz-Target=AppRunner.ListServices: post: operationId: ListServices description: Returns a list of running App Runner services in your Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListServicesResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListServicesRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.ListServices 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' /#X-Amz-Target=AppRunner.ListTagsForResource: post: operationId: ListTagsForResource description: List tags that are associated with for an App Runner resource. The response contains a list of tag key-value pairs. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceResponse' '480': description: ResourceNotFoundException content: application/json: schema: $ref: '#/components/schemas/ResourceNotFoundException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' '482': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '483': description: InvalidStateException content: application/json: schema: $ref: '#/components/schemas/InvalidStateException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListTagsForResourceRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.ListTagsForResource 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' /#X-Amz-Target=AppRunner.ListVpcConnectors: post: operationId: ListVpcConnectors description: Returns a list of App Runner VPC connectors in your Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVpcConnectorsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListVpcConnectorsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.ListVpcConnectors 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' /#X-Amz-Target=AppRunner.ListVpcIngressConnections: post: operationId: ListVpcIngressConnections description: Return a list of App Runner VPC Ingress Connections in your Amazon Web Services account. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListVpcIngressConnectionsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' '481': description: InternalServiceErrorException content: application/json: schema: $ref: '#/components/schemas/InternalServiceErrorException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListVpcIngressConnectionsRequest' parameters: - name: MaxResults in: query schema: type: string description: Pagination limit required: false - name: NextToken in: query schema: type: string description: Pagination token required: false - name: X-Amz-Target in: header required: true schema: type: string enum: - AppRunner.ListVpcIngressConnections 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' /#X-Amz-Target=AppRunner.PauseService: post: operationId: PauseService description:Pause an active App Runner service. App Runner reduces compute capacity for the service to zero and loses state (for example, ephemeral storage is removed).
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.
Resume an active App Runner service. App Runner provisions compute capacity for the service.
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.
Initiate a manual deployment of the latest commit in a source code repository or the latest image in a source image repository to an App Runner service.
For a source code repository, App Runner retrieves the commit and builds a Docker image. For a source image repository, App Runner retrieves the latest Docker image. In both cases, App Runner then deploys the new image to your service and starts a new container instance.
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.
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.
Update an existing App Runner VPC Ingress Connection resource. The VPC Ingress Connection must be in one of the following states to be updated:
AVAILABLE
FAILED_CREATION
FAILED_UPDATE
example.com), a subdomain (for example, login.example.com or
admin.login.example.com), or a wildcard (for example, *.example.com).
EnableWWWSubdomain:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: 'Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain.
Default: true
A name for the auto scaling configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this
name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
The name DefaultConfiguration is reserved
(it's the configuration that App Runner uses if you don't provide a custome one). You can't use it to create a new auto scaling configuration, and you can't create a revision of it.
When you want to use your own auto scaling configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.
The maximum number of concurrent requests that you want an instance to process. If the number of concurrent requests exceeds this limit, App Runner scales up your service.
Default: 100
The minimum number of instances that App Runner provisions for your service. The service always has at least MinSize provisioned instances. Some of them actively
serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all the
provisioned instances. You pay for CPU usage of only the active subset.
App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
Default: 1
The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traffic for your service.
Default: 25
A name for the observability configuration. When you use it for the first time in an Amazon Web Services Region, App Runner creates revision number 1 of this
name. When you use the same name in subsequent calls, App Runner creates incremental revisions of the configuration.
The name DefaultConfiguration is reserved.
You can't use it to create a new observability configuration, and you can't create a revision of it.
When you want to use your own observability configuration for your App Runner service, create a configuration with a different name, and then provide it when you create or update your service.
The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service. If not provided, App Runner associates the latest revision of a default auto scaling configuration.
Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3
Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability
A list of IDs of subnets that App Runner should use when it associates your service with a custom Amazon VPC. Specify IDs of subnets of a single Amazon VPC. App Runner determines the Amazon VPC from the subnets you specify.
App Runner currently only provides support for IPv4.
The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want to delete.
The ARN can be a full auto scaling configuration ARN, or a
partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.
The Amazon Resource Name (ARN) of the App Runner observability configuration that you want to delete.
The ARN can be a full observability configuration ARN, or a
partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is deleted.
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want to delete.
The ARN must be a full VPC connector ARN.
DeleteVpcIngressConnectionResponse: type: object required: - VpcIngressConnection properties: VpcIngressConnection: allOf: - $ref: '#/components/schemas/VpcIngressConnection' - description: A description of the App Runner VPC Ingress Connection that this request just deleted. DeleteVpcIngressConnectionRequest: type: object required: - VpcIngressConnectionArn title: DeleteVpcIngressConnectionRequest properties: VpcIngressConnectionArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want to delete. DescribeAutoScalingConfigurationResponse: type: object required: - AutoScalingConfiguration properties: AutoScalingConfiguration: allOf: - $ref: '#/components/schemas/AutoScalingConfiguration' - description: A full description of the App Runner auto scaling configuration that you specified in this request. DescribeAutoScalingConfigurationRequest: type: object required: - AutoScalingConfigurationArn title: DescribeAutoScalingConfigurationRequest properties: AutoScalingConfigurationArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description:The Amazon Resource Name (ARN) of the App Runner auto scaling configuration that you want a description for.
The ARN can be a full auto scaling configuration ARN, or
a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is
described.
MaxResults records per call.
VpcDNSTargets:
allOf:
- $ref: '#/components/schemas/VpcDNSTargetList'
- description: 'DNS Target records for the custom domains of this Amazon VPC. '
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
DescribeCustomDomainsRequest:
type: object
required:
- ServiceArn
title: DescribeCustomDomainsRequest
properties:
ServiceArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of the App Runner service that you want associated custom domain names to be described for.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
The maximum number of results that each response (result page) can include. It's used for a paginated request.
If you don't specify MaxResults, the
request retrieves all available results in a single response.
The Amazon Resource Name (ARN) of the App Runner observability configuration that you want a description for.
The ARN can be a full observability configuration ARN,
or a partial ARN ending with either .../name or .../name/revision . If a revision isn't specified, the latest active revision is
described.
The Amazon Resource Name (ARN) of the App Runner VPC connector that you want a description for.
The ARN must be a full VPC connector ARN.
DescribeVpcIngressConnectionResponse: type: object required: - VpcIngressConnection properties: VpcIngressConnection: allOf: - $ref: '#/components/schemas/VpcIngressConnection' - description: A description of the App Runner VPC Ingress Connection that you specified in this request. DescribeVpcIngressConnectionRequest: type: object required: - VpcIngressConnectionArn title: DescribeVpcIngressConnectionRequest properties: VpcIngressConnectionArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of the App Runner VPC Ingress Connection that you want a description for. DisassociateCustomDomainResponse: type: object required: - DNSTarget - ServiceArn - CustomDomain - VpcDNSTargets properties: DNSTarget: allOf: - $ref: '#/components/schemas/String' - description: The App Runner subdomain of the App Runner service. The disassociated custom domain name was mapped to this target name. ServiceArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of the App Runner service that a custom domain name is disassociated from. CustomDomain: allOf: - $ref: '#/components/schemas/CustomDomain' - description: A description of the domain name that's being disassociated. VpcDNSTargets: allOf: - $ref: '#/components/schemas/VpcDNSTargetList' - description: 'DNS Target records for the custom domains of this Amazon VPC. ' DisassociateCustomDomainRequest: type: object required: - ServiceArn - DomainName title: DisassociateCustomDomainRequest properties: ServiceArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of the App Runner service that you want to disassociate a custom domain name from. DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: The domain name that you want to disassociate from the App Runner service. ListAutoScalingConfigurationsResponse: type: object required: - AutoScalingConfigurationSummaryList properties: AutoScalingConfigurationSummaryList: allOf: - $ref: '#/components/schemas/AutoScalingConfigurationSummaryList' - description: A list of summary information records for auto scaling configurations. In a paginated request, the request returns up toMaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
ListAutoScalingConfigurationsRequest:
type: object
title: ListAutoScalingConfigurationsRequest
properties:
AutoScalingConfigurationName:
allOf:
- $ref: '#/components/schemas/AutoScalingConfigurationName'
- description: The name of the App Runner auto scaling configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner
returns revisions of all active configurations.
LatestOnly:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Set to true to list only the latest revision for each requested configuration name.
Set to false to list all revisions for each requested configuration
name.
Default: true
The maximum number of results to include in each response (result page). It's used for a paginated request.
If you don't specify MaxResults, the request
retrieves all available results in a single response.
A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
MaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token that you can pass in a subsequent request to get the next result page. Returned in a paginated request.
ListConnectionsRequest:
type: object
title: ListConnectionsRequest
properties:
ConnectionName:
allOf:
- $ref: '#/components/schemas/ConnectionName'
- description: If specified, only this connection is returned. If not specified, the result isn't filtered by name.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to include in each response (result page). Used for a paginated request.
If you don't specify MaxResults, the request
retrieves all available results in a single response.
A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
MaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
ListObservabilityConfigurationsRequest:
type: object
title: ListObservabilityConfigurationsRequest
properties:
ObservabilityConfigurationName:
allOf:
- $ref: '#/components/schemas/ObservabilityConfigurationName'
- description: The name of the App Runner observability configuration that you want to list. If specified, App Runner lists revisions that share this name. If not specified, App Runner
returns revisions of all active configurations.
LatestOnly:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: 'Set to true to list only the latest revision for each requested configuration name.
Set to false to list all revisions for each requested configuration
name.
Default: true
The maximum number of results to include in each response (result page). It's used for a paginated request.
If you don't specify MaxResults, the request
retrieves all available results in a single response.
A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
MaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
ListOperationsRequest:
type: object
required:
- ServiceArn
title: ListOperationsRequest
properties:
ServiceArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of the App Runner service that you want a list of operations for.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
The maximum number of results to include in each response (result page). It's used for a paginated request.
If you don't specify MaxResults, the request
retrieves all available results in a single response.
MaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
ListServicesRequest:
type: object
title: ListServicesRequest
properties:
NextToken:
allOf:
- $ref: '#/components/schemas/String'
- description: A token from a previous result page. Used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
The maximum number of results to include in each response (result page). It's used for a paginated request.
If you don't specify MaxResults, the request
retrieves all available results in a single response.
The Amazon Resource Name (ARN) of the resource that a tag list is requested for.
It must be the ARN of an App Runner resource.
ListVpcConnectorsResponse: type: object required: - VpcConnectors properties: VpcConnectors: allOf: - $ref: '#/components/schemas/VpcConnectors' - description: A list of information records for VPC connectors. In a paginated request, the request returns up toMaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
ListVpcConnectorsRequest:
type: object
title: ListVpcConnectorsRequest
properties:
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to include in each response (result page). It's used for a paginated request.
If you don't specify MaxResults, the request
retrieves all available results in a single response.
A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
MaxResults records for each call.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token that you can pass in a subsequent request to get the next result page. It's returned in a paginated request.
ListVpcIngressConnectionsRequest:
type: object
title: ListVpcIngressConnectionsRequest
properties:
Filter:
allOf:
- $ref: '#/components/schemas/ListVpcIngressConnectionsFilter'
- description: The VPC Ingress Connections to be listed based on either the Service Arn or Vpc Endpoint Id, or both.
MaxResults:
allOf:
- $ref: '#/components/schemas/MaxResults'
- description: The maximum number of results to include in each response (result page). It's used for a paginated request.
If you don't specify MaxResults, the request
retrieves all available results in a single response.
A token from a previous result page. It's used for a paginated request. The request retrieves the next result page. All other parameter values must be identical to the ones that are specified in the initial request.
If you don't specify NextToken, the request retrieves the first result page.
The Amazon Resource Name (ARN) of the resource that you want to update tags for.
It must be the ARN of an App Runner resource.
Tags: allOf: - $ref: '#/components/schemas/TagList' - description: A list of tag key-value pairs to add or update. If a key is new to the resource, the tag is added with the provided value. If a key is already associated with the resource, the value of the tag is updated. UntagResourceResponse: type: object properties: {} UntagResourceRequest: type: object required: - ResourceArn - TagKeys title: UntagResourceRequest properties: ResourceArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description:The Amazon Resource Name (ARN) of the resource that you want to remove tags from.
It must be the ARN of an App Runner resource.
TagKeys: allOf: - $ref: '#/components/schemas/TagKeyList' - description: A list of tag keys that you want to remove. 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.
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.
example.com), a subdomain (for example, login.example.com or
admin.login.example.com), or a wildcard (for example, *.example.com).
EnableWWWSubdomain:
allOf:
- $ref: '#/components/schemas/NullableBoolean'
- description: When true, the subdomain www.DomainName is associated with the App Runner service in addition to the base domain.
CertificateValidationRecords:
allOf:
- $ref: '#/components/schemas/CertificateValidationRecordList'
- description: A list of certificate CNAME records that's used for this domain name.
Status:
allOf:
- $ref: '#/components/schemas/CustomDomainAssociationStatus'
- description: The current state of the domain name association.
description: Describes a custom domain that's associated with an App Runner service.
VpcDNSTargetList:
type: array
items:
$ref: '#/components/schemas/VpcDNSTarget'
RoleArn:
type: string
pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):iam::[0-9]{12}:(role|role\/service-role)\/[\w+=,.@\-/]{1,1000}
minLength: 29
maxLength: 1024
AuthenticationConfiguration:
type: object
properties:
ConnectionArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of the App Runner connection that enables the App Runner service to connect to a source repository. It's required for GitHub code repositories.
AccessRoleArn:
allOf:
- $ref: '#/components/schemas/RoleArn'
- description: The Amazon Resource Name (ARN) of the IAM role that grants the App Runner service access to a source repository. It's required for ECR image repositories (but not for ECR
Public repositories).
description: Describes resources needed to authenticate access to some source repositories. The specific resource depends on the repository provider.
AutoScalingConfigurationName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{3,31}'
minLength: 4
maxLength: 32
Integer:
type: integer
Boolean:
type: boolean
AutoScalingConfigurationStatus:
type: string
enum:
- ACTIVE
- INACTIVE
Timestamp:
type: string
format: date-time
AutoScalingConfiguration:
type: object
properties:
AutoScalingConfigurationArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of this auto scaling configuration.
AutoScalingConfigurationName:
allOf:
- $ref: '#/components/schemas/AutoScalingConfigurationName'
- description: The customer-provided auto scaling configuration name. It can be used in multiple revisions of a configuration.
AutoScalingConfigurationRevision:
allOf:
- $ref: '#/components/schemas/Integer'
- description: "The revision of this auto scaling configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same AutoScalingConfigurationName."
Latest:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: It's set to true for the configuration with the highest Revision among all configurations that share the same
AutoScalingConfigurationName. It's set to false otherwise.
Status:
allOf:
- $ref: '#/components/schemas/AutoScalingConfigurationStatus'
- description: The current state of the auto scaling configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive
configuration revisions are permanently removed some time after they are deleted.
MaxConcurrency:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The maximum number of concurrent requests that an instance processes. If the number of concurrent requests exceeds this limit, App Runner scales the service up.
MinSize:
allOf:
- $ref: '#/components/schemas/Integer'
- description: The minimum number of instances that App Runner provisions for a service. The service always has at least MinSize provisioned instances. Some of them actively
serve traffic. The rest of them (provisioned and inactive instances) are a cost-effective compute capacity reserve and are ready to be quickly activated. You pay for memory usage of all
the provisioned instances. You pay for CPU usage of only the active subset.
App Runner temporarily doubles the number of provisioned instances during deployments, to maintain the same capacity for both old and new code.
MaxSize: allOf: - $ref: '#/components/schemas/Integer' - description: The maximum number of instances that a service scales up to. At mostMaxSize instances actively serve traffic for your service.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the auto scaling configuration was created. It's in Unix time stamp format.
DeletedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the auto scaling configuration was deleted. It's in Unix time stamp format.
description: Describes an App Runner automatic scaling configuration resource.
A higher MinSize increases the spread of your App Runner service over more Availability
Zones in the Amazon Web Services Region. The tradeoff is a higher minimal cost.
A lower MaxSize controls your cost. The tradeoff is lower responsiveness during peak
demand.
Multiple revisions of a configuration might have the same AutoScalingConfigurationName and different AutoScalingConfigurationRevision values.
\"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.
AutoScalingConfigurationSummaryList: type: array items: $ref: '#/components/schemas/AutoScalingConfigurationSummary' BuildCommand: type: string pattern: '[^\x0a\x0d]+' format: password CertificateValidationRecordStatus: type: string enum: - PENDING_VALIDATION - SUCCESS - FAILED CertificateValidationRecord: type: object properties: Name: allOf: - $ref: '#/components/schemas/String' - description: The certificate CNAME record name. Type: allOf: - $ref: '#/components/schemas/String' - description: The record type, alwaysCNAME.
Value:
allOf:
- $ref: '#/components/schemas/String'
- description: The certificate CNAME record value.
Status:
allOf:
- $ref: '#/components/schemas/CertificateValidationRecordStatus'
- description: The current state of the certificate CNAME record validation. It should change to SUCCESS after App Runner completes validation with your DNS.
description: Describes a certificate CNAME record to add to your DNS. For more information, see AssociateCustomDomain.
CertificateValidationRecordList:
type: array
items:
$ref: '#/components/schemas/CertificateValidationRecord'
ConfigurationSource:
type: string
enum:
- REPOSITORY
- API
CodeConfigurationValues:
type: object
required:
- Runtime
properties:
Runtime:
allOf:
- $ref: '#/components/schemas/Runtime'
- description: A runtime environment type for building and running an App Runner service. It represents a programming language runtime.
BuildCommand:
allOf:
- $ref: '#/components/schemas/BuildCommand'
- description: The command App Runner runs to build your application.
StartCommand:
allOf:
- $ref: '#/components/schemas/StartCommand'
- description: The command App Runner runs to start your application.
Port:
allOf:
- $ref: '#/components/schemas/String'
- description: '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.
CodeConfiguration:
type: object
required:
- ConfigurationSource
properties:
ConfigurationSource:
allOf:
- $ref: '#/components/schemas/ConfigurationSource'
- description: 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.
Runtime:
type: string
enum:
- PYTHON_3
- NODEJS_12
- NODEJS_14
- CORRETTO_8
- CORRETTO_11
- NODEJS_16
- GO_1
- DOTNET_6
- PHP_81
- RUBY_31
StartCommand:
type: string
pattern: '[^\x0a\x0d]+'
format: password
RuntimeEnvironmentVariables:
type: object
additionalProperties:
$ref: '#/components/schemas/RuntimeEnvironmentVariablesValue'
RuntimeEnvironmentSecrets:
type: object
additionalProperties:
$ref: '#/components/schemas/RuntimeEnvironmentSecretsValue'
SourceCodeVersion:
type: object
required:
- Type
- Value
properties:
Type:
allOf:
- $ref: '#/components/schemas/SourceCodeVersionType'
- description: 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. 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.
AVAILABLE, you can use the connection to create an App Runner service.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The App Runner connection creation time, expressed as a Unix time stamp.
description: Describes an App Runner connection resource.
ConnectionSummary:
type: object
properties:
ConnectionName:
allOf:
- $ref: '#/components/schemas/ConnectionName'
- description: The customer-provided connection name.
ConnectionArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of this connection.
ProviderType:
allOf:
- $ref: '#/components/schemas/ProviderType'
- description: The source repository provider.
Status:
allOf:
- $ref: '#/components/schemas/ConnectionStatus'
- description: The current state of the App Runner connection. When the state is AVAILABLE, you can use the connection to create an App Runner service.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The App Runner connection creation time, expressed as a Unix time stamp.
description: Provides summary information about an App Runner connection resource.
ConnectionSummaryList:
type: array
items:
$ref: '#/components/schemas/ConnectionSummary'
Cpu:
type: string
pattern: 256|512|1024|2048|4096|(0.25|0.5|1|2|4) vCPU
minLength: 3
maxLength: 9
TagList:
type: array
items:
$ref: '#/components/schemas/Tag'
ObservabilityConfigurationName:
type: string
pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{3,31}'
minLength: 4
maxLength: 32
TraceConfiguration:
type: object
required:
- Vendor
properties:
Vendor:
allOf:
- $ref: '#/components/schemas/TracingVendor'
- description: The implementation provider chosen for tracing App Runner services.
description: Describes the configuration of the tracing feature within an App Runner observability configuration.
ObservabilityConfiguration:
type: object
properties:
ObservabilityConfigurationArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of this observability configuration.
ObservabilityConfigurationName:
allOf:
- $ref: '#/components/schemas/ObservabilityConfigurationName'
- description: The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.
TraceConfiguration:
allOf:
- $ref: '#/components/schemas/TraceConfiguration'
- description: The configuration of the tracing feature within this observability configuration. If not specified, tracing isn't enabled.
ObservabilityConfigurationRevision:
allOf:
- $ref: '#/components/schemas/Integer'
- description: "The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same ObservabilityConfigurationName."
Latest:
allOf:
- $ref: '#/components/schemas/Boolean'
- description: It's set to true for the configuration with the highest Revision among all configurations that share the same
ObservabilityConfigurationName. It's set to false otherwise.
Status:
allOf:
- $ref: '#/components/schemas/ObservabilityConfigurationStatus'
- description: The current state of the observability configuration. If the status of a configuration revision is INACTIVE, it was deleted and can't be used. Inactive
configuration revisions are permanently removed some time after they are deleted.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the observability configuration was created. It's in Unix time stamp format.
DeletedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the observability configuration was deleted. It's in Unix time stamp format.
description: Describes an App Runner observability configuration resource. Multiple revisions of a configuration have the same ObservabilityConfigurationName and different
ObservabilityConfigurationRevision values.
The resource is designed to configure multiple features (currently one feature, tracing). This type contains optional members
that describe the configuration of these features (currently one member, TraceConfiguration). If a feature member isn't specified, the feature isn't enabled.
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 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
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
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 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.
UUID: type: string pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}' minLength: 36 maxLength: 36 VpcConnectorName: type: string pattern: '[A-Za-z0-9][A-Za-z0-9\-_]{3,39}' minLength: 4 maxLength: 40 StringList: type: array items: $ref: '#/components/schemas/String' VpcConnector: type: object properties: VpcConnectorName: allOf: - $ref: '#/components/schemas/VpcConnectorName' - description: The customer-provided VPC connector name. VpcConnectorArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of this VPC connector. VpcConnectorRevision: allOf: - $ref: '#/components/schemas/Integer' - description: "The revision of this VPC connector. It's unique among all the active connectors (\"Status\": \"ACTIVE\") that share the same Name.
At this time, App Runner supports only one revision per name.
INACTIVE, it was deleted and can't be used. Inactive connector revisions are
permanently removed some time after they are deleted.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the VPC connector was created. It's in Unix time stamp format.
DeletedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The time when the VPC connector was deleted. It's in Unix time stamp format.
description: Describes an App Runner VPC connector resource. A VPC connector describes the Amazon Virtual Private Cloud (Amazon VPC) that an App Runner service is associated with, and the subnets and security group that are used.
Multiple revisions of a connector might have the same Name and different Revision values.
At this time, App Runner supports only one revision per name.
AVAILABLE, PENDING_CREATION, PENDING_UPDATE,
PENDING_DELETION,FAILED_CREATION, FAILED_UPDATE, FAILED_DELETION, and DELETED.. '
AccountId:
allOf:
- $ref: '#/components/schemas/CustomerAccountId'
- description: The Account Id you use to create the VPC Ingress Connection resource.
DomainName:
allOf:
- $ref: '#/components/schemas/DomainName'
- description: The domain name associated with the VPC Ingress Connection resource.
IngressVpcConfiguration:
allOf:
- $ref: '#/components/schemas/IngressVpcConfiguration'
- description: Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
CreatedAt:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: "The time when the VPC Ingress Connection was created. It's in the Unix time stamp format.
Type: Timestamp
Required: Yes
The time when the App Runner service was deleted. It's in the Unix time stamp format.
Type: Timestamp
Required: No
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.
KmsKeyArn:
type: string
pattern: arn:aws(-[\w]+)*:kms:[a-z\-]+-[0-9]{1}:[0-9]{12}:key\/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}
minLength: 0
maxLength: 256
HealthCheckProtocol:
type: string
enum:
- TCP
- HTTP
HealthCheckPath:
type: string
minLength: 1
HealthCheckInterval:
type: integer
minimum: 1
maximum: 20
HealthCheckTimeout:
type: integer
minimum: 1
maximum: 20
HealthCheckHealthyThreshold:
type: integer
minimum: 1
maximum: 20
HealthCheckUnhealthyThreshold:
type: integer
minimum: 1
maximum: 20
ImageConfiguration:
type: object
properties:
RuntimeEnvironmentVariables:
allOf:
- $ref: '#/components/schemas/RuntimeEnvironmentVariables'
- description: Environment variables that are available to your running App Runner service. An array of key-value pairs.
StartCommand:
allOf:
- $ref: '#/components/schemas/StartCommand'
- description: 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.
Port:
allOf:
- $ref: '#/components/schemas/String'
- description: '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 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. 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 toTrue. To make the service privately accessible,
from only within an Amazon VPC set it to False. '
description: Network configuration settings for inbound network traffic.
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
MaxResults:
type: integer
minimum: 1
maximum: 100
NextToken:
type: string
pattern: .*
minLength: 1
maxLength: 1024
ObservabilityConfigurationSummaryList:
type: array
items:
$ref: '#/components/schemas/ObservabilityConfigurationSummary'
ListOperationsMaxResults:
type: integer
minimum: 1
maximum: 20
OperationSummaryList:
type: array
items:
$ref: '#/components/schemas/OperationSummary'
ServiceMaxResults:
type: integer
minimum: 1
maximum: 20
ServiceSummaryList:
type: array
items:
$ref: '#/components/schemas/ServiceSummary'
VpcConnectors:
type: array
items:
$ref: '#/components/schemas/VpcConnector'
ListVpcIngressConnectionsFilter:
type: object
properties:
ServiceArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: 'The Amazon Resource Name (ARN) of a service to filter by. '
VpcEndpointId:
allOf:
- $ref: '#/components/schemas/String'
- description: 'The ID of a VPC Endpoint to filter by. '
description: Returns a list of VPC Ingress Connections based on the filter provided. It can return either ServiceArn or VpcEndpointId, or both.
VpcIngressConnectionSummaryList:
type: array
items:
$ref: '#/components/schemas/VpcIngressConnectionSummary'
ObservabilityConfigurationStatus:
type: string
enum:
- ACTIVE
- INACTIVE
ObservabilityConfigurationSummary:
type: object
properties:
ObservabilityConfigurationArn:
allOf:
- $ref: '#/components/schemas/AppRunnerResourceArn'
- description: The Amazon Resource Name (ARN) of this observability configuration.
ObservabilityConfigurationName:
allOf:
- $ref: '#/components/schemas/ObservabilityConfigurationName'
- description: The customer-provided observability configuration name. It can be used in multiple revisions of a configuration.
ObservabilityConfigurationRevision:
allOf:
- $ref: '#/components/schemas/Integer'
- description: "The revision of this observability configuration. It's unique among all the active configurations (\"Status\": \"ACTIVE\") that share the same ObservabilityConfigurationName."
description: Provides summary information about an App Runner observability configuration resource.
This type contains limited information about an observability configuration. It includes only identification information, without configuration details. It's returned by the ListObservabilityConfigurations action. Complete configuration information is returned by the CreateObservabilityConfiguration, DescribeObservabilityConfiguration, and DeleteObservabilityConfiguration actions using the ObservabilityConfiguration type.
OperationStatus: type: string enum: - PENDING - IN_PROGRESS - FAILED - SUCCEEDED - ROLLBACK_IN_PROGRESS - ROLLBACK_FAILED - ROLLBACK_SUCCEEDED OperationType: type: string enum: - START_DEPLOYMENT - CREATE_SERVICE - PAUSE_SERVICE - RESUME_SERVICE - DELETE_SERVICE - UPDATE_SERVICE OperationSummary: type: object properties: Id: allOf: - $ref: '#/components/schemas/UUID' - description: A unique ID of this operation. It's unique in the scope of the App Runner service. Type: allOf: - $ref: '#/components/schemas/OperationType' - description: The type of operation. It indicates a specific action that occured. Status: allOf: - $ref: '#/components/schemas/OperationStatus' - description: The current state of the operation. TargetArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of the resource that the operation acted on (for example, an App Runner service). StartedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the operation started. It's in the Unix time stamp format. EndedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the operation ended. It's in the Unix time stamp format. UpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the operation was last updated. It's in the Unix time stamp format. description: Provides summary information for an operation that occurred on an App Runner service. RuntimeEnvironmentSecretsValue: type: string minLength: 1 maxLength: 2048 format: password RuntimeEnvironmentSecretsName: type: string minLength: 1 maxLength: 2048 format: password RuntimeEnvironmentVariablesValue: type: string pattern: .* minLength: 0 maxLength: 51200 format: password RuntimeEnvironmentVariablesKey: type: string pattern: .* minLength: 1 maxLength: 51200 format: password ServiceId: type: string pattern: '[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}' minLength: 32 maxLength: 32 ServiceStatus: type: string enum: - CREATE_FAILED - RUNNING - DELETED - DELETE_FAILED - PAUSED - OPERATION_IN_PROGRESS ServiceSummary: type: object properties: ServiceName: allOf: - $ref: '#/components/schemas/ServiceName' - description: The customer-provided service name. ServiceId: allOf: - $ref: '#/components/schemas/ServiceId' - description: An ID that App Runner generated for this service. It's unique within the Amazon Web Services Region. ServiceArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of this service. ServiceUrl: allOf: - $ref: '#/components/schemas/String' - description: A subdomain URL that App Runner generated for this service. You can use this URL to access your service web application. CreatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the App Runner service was created. It's in the Unix time stamp format. UpdatedAt: allOf: - $ref: '#/components/schemas/Timestamp' - description: The time when the App Runner service was last updated. It's in theUnix time stamp format. Status: allOf: - $ref: '#/components/schemas/ServiceStatus' - description:The current state of the App Runner service. These particular values mean the following.
CREATE_FAILED – The service failed to create. 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.
Provides summary information for an App Runner service.
This type contains limited information about a service. It doesn't include configuration details. It's returned by the ListServices action. Complete service information is returned by the CreateService, DescribeService, and DeleteService actions using the Service type.
SourceCodeVersionType: type: string enum: - BRANCH TagKey: type: string pattern: ^(?!aws:).+ minLength: 1 maxLength: 128 TagValue: type: string pattern: .* minLength: 0 maxLength: 256 Tag: type: object properties: Key: allOf: - $ref: '#/components/schemas/TagKey' - description: The key of the tag. Value: allOf: - $ref: '#/components/schemas/TagValue' - description: The value of the tag. description: Describes a tag that is applied to an App Runner resource. A tag is a metadata item consisting of a key-value pair. TagKeyList: type: array items: $ref: '#/components/schemas/TagKey' TracingVendor: type: string enum: - AWSXRAY VpcConnectorStatus: type: string enum: - ACTIVE - INACTIVE VpcDNSTarget: type: object properties: VpcIngressConnectionArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: The Amazon Resource Name (ARN) of the VPC Ingress Connection that is associated with your service. VpcId: allOf: - $ref: '#/components/schemas/String' - description: The ID of the Amazon VPC that is associated with the custom domain name of the target DNS. DomainName: allOf: - $ref: '#/components/schemas/DomainName' - description: The domain name of your target DNS that is associated with the Amazon VPC. description: DNS Target record for a custom domain of this Amazon VPC. VpcIngressConnectionStatus: type: string enum: - AVAILABLE - PENDING_CREATION - PENDING_UPDATE - PENDING_DELETION - FAILED_CREATION - FAILED_UPDATE - FAILED_DELETION - DELETED VpcIngressConnectionSummary: type: object properties: VpcIngressConnectionArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: 'The Amazon Resource Name (ARN) of the VPC Ingress Connection. ' ServiceArn: allOf: - $ref: '#/components/schemas/AppRunnerResourceArn' - description: 'The Amazon Resource Name (ARN) of the service associated with the VPC Ingress Connection. ' description: Provides summary information about an VPC Ingress Connection, which includes its VPC Ingress Connection ARN and its associated Service ARN. security: - hmac: []