AWS App Runner

(1)

AWS App Runner

API Reference

API Version 2020-05-15

(2)

AWS App Runner: API Reference

Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be aﬃliated with, connected to, or sponsored by Amazon.

(3)

Welcome

AWS App Runner is an application service that provides a fast, simple, and cost-eﬀective way to go directly from an existing container image or source code to a running service in the AWS Cloud in seconds. You don't need to learn new technologies, decide which compute service to use, or understand how to provision and conﬁgure AWS 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 AWS App Runner Developer Guide. For release information, see the AWS 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-speciﬁc endpoints that App Runner supports, see AWS App Runner endpoints and quotas in the AWS General Reference.

This document was last published on March 6, 2022.

(10)

Actions

The following actions are supported:

• AssociateCustomDomain (p. 3)

• CreateAutoScalingConﬁguration (p. 7)

• CreateConnection (p. 11)

• CreateService (p. 14)

• CreateVpcConnector (p. 22)

• DeleteAutoScalingConﬁguration (p. 25)

• DeleteConnection (p. 29)

• DeleteService (p. 32)

• DeleteVpcConnector (p. 37)

• DescribeAutoScalingConﬁguration (p. 40)

• DescribeCustomDomains (p. 44)

• DescribeService (p. 48)

• DescribeVpcConnector (p. 52)

• DisassociateCustomDomain (p. 55)

• ListAutoScalingConﬁgurations (p. 59)

• ListConnections (p. 63)

• ListOperations (p. 67)

• ListServices (p. 70)

• ListTagsForResource (p. 73)

• ListVpcConnectors (p. 76)

• PauseService (p. 79)

• ResumeService (p. 84)

• StartDeployment (p. 89)

• TagResource (p. 92)

• UntagResource (p. 95)

• UpdateService (p. 98)

(11)

AssociateCustomDomain

Associate your own domain name with the AWS App Runner subdomain URL of your App Runner service.

After you call AssociateCustomDomain and receive a successful response, use the information in the CustomDomain (p. 120) 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).

Request Syntax

{

"DomainName": "string", "EnableWWWSubdomain": boolean, "ServiceArn": "string"

}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters (p. 141).

The request accepts the following data in JSON format.

DomainName (p. 3)

A custom domain endpoint to associate. Specify a root domain (for example, example.com), a subdomain (for example, login.example.com or admin.login.example.com), or a wildcard (for example, *.example.com).

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

EnableWWWSubdomain (p. 3)

Set to true to associate the subdomain www.DomainName with the App Runner service in addition to the base domain.

Default: true Type: Boolean Required: No ServiceArn (p. 3)

The Amazon Resource Name (ARN) of the App Runner service that you want to associate a custom domain name with.

Type: String

(12)

Response Syntax

Pattern: arn:aws(-[\w]+)*:[a-z0-9-\\.]{0,63}:[a-z0-9-\\.]{0,63}:[0-9]{12}:(\w|

\/|-){1,1011}

Required: Yes

Response Syntax

{

"CustomDomain": {

"CertificateValidationRecords": [ {

"Name": "string", "Status": "string", "Type": "string", "Value": "string"

} ],

"DomainName": "string",

"EnableWWWSubdomain": boolean, "Status": "string"

},

"DNSTarget": "string", "ServiceArn": "string"

}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

CustomDomain (p. 4)

A description of the domain name that's being associated.

Type: CustomDomain (p. 120) object DNSTarget (p. 4)

The App Runner subdomain of the App Runner service. The custom domain name is mapped to this target name.

Type: String

Pattern: .*

ServiceArn (p. 4)

The Amazon Resource Name (ARN) of the App Runner service with which a custom domain name is associated.

Type: String

\/|-){1,1011}

(13)

Errors

For information about the errors that are common to all actions, see Common Errors (p. 143).

InternalServiceErrorException

An unexpected service exception occurred.

HTTP Status Code: 500 InvalidRequestException

One or more input parameters aren't valid. Refer to the API action's document page, correct the input parameters, and try the action again.

HTTP Status Code: 400 InvalidStateException

You can't perform this action when the resource is in its current state.

HTTP Status Code: 400

Examples

Associate a domain name and the www subdomain with a service

This example illustrates how to associate a custom domain name that you control with an App Runner service. The domain name is the root domain example.com, including the special-case subdomain www.example.com.

Sample Request

$ aws apprunner associate-custom-domain --cli-input-json "`cat`"

{ "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python- app/8fe1e10304f84fd2b0df550fe98a71fa",

"DomainName": "example.com", "EnableWWWSubdomain": true }

Sample Response

{ "CustomDomain": {

"CertificateValidationRecords": [ {

"Name": "_70d3f50a94f7c72dc28784cf55db2f6b.example.com", "Status": "PENDING_VALIDATION",

"Type": "CNAME",

"Value": "_1270c137383c6307b6832db02504c4b0.bsgbmzkfwj.acm-validations.aws."

}, {

"Name": "_287870d3f50a94f7c72dc4cf55db2f6b.www.example.com", "Status": "PENDING_VALIDATION",

"Type": "CNAME",

"Value": "_832db01270c137383c6307b62504c4b0.mzkbsgbfwj.acm-validations.aws."

(14)

See Also

} ],

"DomainName": "example.com", "EnableWWWSubdomain": true, "Status": "CREATING"

},

"DNSTarget": "psbqam834h.us-east-1.awsapprunner.com",

"ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python- app/8fe1e10304f84fd2b0df550fe98a71fa"

}

CreateAutoScalingConﬁguration

Create an AWS App Runner automatic scaling conﬁguration resource. App Runner requires this resource when you create App Runner services that require non-default auto scaling settings. You can share an auto scaling conﬁguration across multiple services.

Create multiple revisions of a conﬁguration by calling this action multiple times using the same AutoScalingConfigurationName. The call returns incremental

AutoScalingConfigurationRevision values. When you create a service, you can set it to use the latest active revision of an auto scaling conﬁguration or a speciﬁc revision.

Conﬁgure a higher MinSize to increase the spread of your App Runner service over more Availability Zones in the AWS Region. The tradeoﬀ is a higher minimal cost.

Conﬁgure a lower MaxSize to control your cost. The tradeoﬀ is lower responsiveness during peak demand.

Request Syntax

{ "AutoScalingConfigurationName": "string", "MaxConcurrency": number,

"MaxSize": number, "MinSize": number, "Tags": [

{

"Key": "string", "Value": "string"

} ]}

Request Parameters

AutoScalingConﬁgurationName (p. 7)

A name for the auto scaling configuration. When you use it for the first time in an AWS 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.

NoteThe name DefaultConfiguration is reserved (it's the conﬁguration that App Runner uses if you don't provide a custome one). You can't use it to create a new auto scaling conﬁguration, 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.

Type: String

Pattern: [A-Za-z0-9][A-Za-z0-9\-_]{3,31}

(16)

Response Syntax

Required: Yes MaxConcurrency (p. 7)

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 Type: Integer

Valid Range: Minimum value of 1. Maximum value of 200.

Required: No MaxSize (p. 7)

The maximum number of instances that your service scales up to. At most MaxSize instances actively serve traﬃc for your service.

Required: No MinSize (p. 7)

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 traﬃc. The rest of them (provisioned and inactive instances) are a cost-eﬀective 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.

Required: No Tags (p. 7)

A list of metadata items that you can associate with your auto scaling conﬁguration resource. A tag is a key-value pair.

Type: Array of Tag (p. 138) objects Required: No

Response Syntax

{

"AutoScalingConfiguration": {

"AutoScalingConfigurationArn": "string",

(17)

Response Elements

"AutoScalingConfigurationName": "string", "AutoScalingConfigurationRevision": number, "CreatedAt": number,

"DeletedAt": number, "Latest": boolean,

"MaxConcurrency": number, "MaxSize": number, "MinSize": number, "Status": "string"

}}

Response Elements

AutoScalingConﬁguration (p. 8)

A description of the App Runner auto scaling conﬁguration that's created by this request.

Type: AutoScalingConﬁguration (p. 106) object

Errors

HTTP Status Code: 400 ServiceQuotaExceededException

App Runner can't create this resource. You've reached your account quota for this resource type.

For App Runner per-resource quotas, see AWS App Runner endpoints and quotas in the AWS General Reference.

Examples

Create a high availability auto scaling conﬁguration

This example illustrates how to create an auto scaling configuration optimized for high availability by setting MinSize to 5. With this configuration, App Runner attempts to spread your service instances over the most Availability Zones possible, up to five, depending on the AWS Region.

(18)

See Also

The call returns an AutoScalingConfiguration object with the other settings set to their defaults. In the example, this is the ﬁrst call to create a conﬁguration named high-availability. The revision is set to 1, and it's the latest revision.

Sample Request

$ aws apprunner create-auto-scaling-configuration --cli-input-json "`cat`"

{

"AutoScalingConfigurationName": "high-availability", "MinSize": 5

}

Sample Response

{ "AutoScalingConfiguration": {

"AutoScalingConfigurationArn": "arn:aws:apprunner:us- east-1:123456789012:autoscalingconfiguration/high-

availability/1/2f50e7656d7819fead0f59672e68042e",

"AutoScalingConfigurationName": "high-availability", "AutoScalingConfigurationRevision": 1,

"CreatedAt": "2020-11-03T00:29:17Z", "Latest": true,

"MaxConcurrency": 100, "MaxSize": 50,

"MinSize": 5 }}

CreateConnection

Create an AWS 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.

Request Syntax

{ "ConnectionName": "string", "ProviderType": "string", "Tags": [

{

} ]}

Request Parameters

ConnectionName (p. 11)

A name for the new connection. It must be unique across all App Runner connections for the AWS account in the AWS Region.

Type: String

Required: Yes ProviderType (p. 11)

The source repository provider.

Type: String

Valid Values: GITHUB Required: Yes

Tags (p. 11)

A list of metadata items that you can associate with your connection resource. A tag is a key-value pair.

(20)

Response Syntax

{

"Connection": {

"ConnectionArn": "string", "ConnectionName": "string", "CreatedAt": number, "ProviderType": "string", "Status": "string"

} }

Response Elements

Connection (p. 12)

A description of the App Runner connection that's created by this request.

Type: Connection (p. 116) object

Errors

Examples

Create a GitHub connection

This example illustrates how to create a connection to a private GitHub code repository. The connection status after a successful call is PENDING_HANDSHAKE. This is because an authentication handshake with

(21)

See Also

the provider still hasn't happened. Complete the handshake using the App Runner console. For more information, see Managing App Runner connections in the AWS App Runner Developer Guide.

Sample Request

$ aws apprunner create-connection --cli-input-json "`cat`"

{ "ConnectionName": "my-github-connection", "ProviderType": "GITHUB"

}

Sample Response

{

"Connection": {

"ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github- connection",

"ConnectionName": "my-github-connection", "Status": "PENDING_HANDSHAKE",

"CreatedAt": "2020-11-03T00:32:51Z", "ProviderType": "GITHUB"

}}

CreateService

Create an AWS 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.

Request Syntax

{ "AutoScalingConfigurationArn": "string", "EncryptionConfiguration": {

"KmsKey": "string"

},

"HealthCheckConfiguration": { "HealthyThreshold": number, "Interval": number,

"Path": "string", "Protocol": "string", "Timeout": number,

"UnhealthyThreshold": number },

"InstanceConfiguration": { "Cpu": "string",

"InstanceRoleArn": "string", "Memory": "string"

},

"NetworkConfiguration": { "EgressConfiguration": { "EgressType": "string", "VpcConnectorArn": "string"

} },

"ServiceName": "string", "SourceConfiguration": {

"AuthenticationConfiguration": { "AccessRoleArn": "string", "ConnectionArn": "string"

},

"AutoDeploymentsEnabled": boolean, "CodeRepository": {

"CodeConfiguration": {

"CodeConfigurationValues": { "BuildCommand": "string", "Port": "string",

"Runtime": "string",

"RuntimeEnvironmentVariables": { "string" : "string"

},

"StartCommand": "string"

},

"ConfigurationSource": "string"

},

"RepositoryUrl": "string", "SourceCodeVersion": { "Type": "string", "Value": "string"

} },

"ImageRepository": { "ImageConfiguration": {

(23)

Request Parameters

"Port": "string",

"RuntimeEnvironmentVariables": { "string" : "string"

},

"ImageIdentifier": "string", "ImageRepositoryType": "string"

} },

"Tags": [ {

} ] }

Request Parameters

AutoScalingConﬁgurationArn (p. 14)

The Amazon Resource Name (ARN) of an App Runner automatic scaling conﬁguration resource that you want to associate with the App Runner service. If not provided, App Runner associates the latest revision of a default auto scaling conﬁguration.

Type: String

\/|-){1,1011}

Required: No

EncryptionConﬁguration (p. 14)

An optional custom encryption key that App Runner uses to encrypt the copy of your source

repository that it maintains and your service logs. By default, App Runner uses an AWS managed key.

Type: EncryptionConﬁguration (p. 122) object Required: No

HealthCheckConﬁguration (p. 14)

The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.

Type: HealthCheckConﬁguration (p. 123) object Required: No

InstanceConﬁguration (p. 14)

The runtime conﬁguration of instances (scaling units) of the App Runner service.

Type: InstanceConﬁguration (p. 127) object

(24)

Response Syntax

Required: No

NetworkConﬁguration (p. 14)

Conﬁguration settings related to network traﬃc of the web application that the App Runner service runs.

Type: NetworkConﬁguration (p. 128) object Required: No

ServiceName (p. 14)

A name for the App Runner service. It must be unique across all the running App Runner services in your AWS account in the AWS Region.

Type: String

Pattern: [A-Za-z0-9][A-Za-z0-9-_]{3,39}

Required: Yes

SourceConﬁguration (p. 14)

The source to deploy to the App Runner service. It can be a code or an image repository.

Type: SourceConﬁguration (p. 137) object Required: Yes

Tags (p. 14)

An optional list of metadata items that you can associate with the App Runner service resource. A tag is a key-value pair.

Response Syntax

{ "OperationId": "string", "Service": {

"AutoScalingConfigurationSummary": { "AutoScalingConfigurationArn": "string", "AutoScalingConfigurationName": "string", "AutoScalingConfigurationRevision": number },

"CreatedAt": number, "DeletedAt": number,

"EncryptionConfiguration": { "KmsKey": "string"

},

(25)

Response Elements

"InstanceRoleArn": "string", "Memory": "string"

},

} },

"ServiceArn": "string", "ServiceId": "string", "ServiceName": "string", "ServiceUrl": "string", "SourceConfiguration": {

},

"RuntimeEnvironmentVariables": { "string" : "string"

},

} },

"ImageRepository": { "ImageConfiguration": { "Port": "string",

},

} },

"Status": "string", "UpdatedAt": number }}

Response Elements

(26)

Errors

OperationId (p. 16)

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.

Type: String

Length Constraints: Fixed length of 36.

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}

Service (p. 16)

A description of the App Runner service that's created by this request.

Type: Service (p. 131) object

Errors

Examples

Create a source code repository service

This example illustrates how to create an App Runner service based on a Python source code repository.

Sample Request

$ aws apprunner create-service --cli-input-json "`cat`"

{

"ServiceName": "python-app", "SourceConfiguration": {

"AuthenticationConfiguration": {

"ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github- connection/e7656250f67242d7819feade6800f59e"

(27)

Examples

},

"AutoDeploymentsEnabled": true, "CodeRepository": {

"RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": {

"Type": "BRANCH", "Value": "main"

},

"ConfigurationSource": "API", "CodeConfigurationValues": { "Runtime": "PYTHON_3",

"BuildCommand": "pip install -r requirements.txt", "StartCommand": "python server.py",

"Port": "8080",

"RuntimeEnvironmentVariables": [ {

"NAME": "Jane"

} ] } } } },

"InstanceConfiguration": { "CPU": "1 vCPU",

"Memory": "3 GB"

}}

Sample Response

{ "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": {

"CreatedAt": "2020-11-20T19:05:25Z", "UpdatedAt": "2020-11-20T19:05:25Z",

"ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python- app/8fe1e10304f84fd2b0df550fe98a71fa",

"ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app",

"ServiceUrl": "psbqam834h.us-east-1.awsapprunner.com", "SourceConfiguration": {

},

"CodeConfigurationValues": {

"BuildCommand": "pip install -r requirements.txt", "Port": "8080",

"Runtime": "PYTHON_3",

"NAME": "Jane"

} ],

"StartCommand": "python server.py"

},

"ConfigurationSource": "Api"

},

"RepositoryUrl": "https://github.com/my-account/python-hello",

(28)

Examples

"SourceCodeVersion": { "Type": "BRANCH", "Value": "main"

} } },

"Status": "OPERATION_IN_PROGRESS", "InstanceConfiguration": {

"CPU": "1 vCPU", "Memory": "3 GB"

},

"NetworkConfiguration": { "EgressConfiguration": { "EgressType": "DEFAULT"

} } }}

Create a source image repository service

This example illustrates how to create an App Runner service based on an image stored in Elastic Container Registry (ECR).

Sample Request

$ aws apprunner create-service --cli-input-json "`cat`"

{ "ServiceName": "golang-container-app", "SourceConfiguration": {

"AccessRoleArn": "arn:aws:iam::123456789012:role/my-ecr-role"

},

"AutoDeploymentsEnabled": true, "ImageRepository": {

"ImageIdentifier": "123456789012.dkr.ecr.us-east-1.amazonaws.com/golang-app:latest", "ImageConfiguration": {

"Port": "8080",

"NAME": "Jane"

} ] },

"ImageRepositoryType": "ECR"

} },

"InstanceConfiguration": { "CPU": "1 vCPU",

"Memory": "3 GB"

}}

Sample Response

{ "OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": {

"ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/golang-container- app/51728f8a20ce46d39b25398a6c8e9d1a",

(29)

See Also

"ServiceId": "51728f8a20ce46d39b25398a6c8e9d1a", "ServiceName": "golang-container-app",

"AccessRoleArn": "arn:aws:iam::123456789012:role/my-ecr-role"

},

"AutoDeploymentsEnabled": true, "ImageRepository": {

"ImageIdentifier": "123456789012.dkr.ecr.us-east-1.amazonaws.com/golang- app:latest",

"ImageConfiguration": { "Port": "8080",

"NAME": "Jane"

} ] },

"ImageRepositoryType": "ECR"

} },

},

} } }}

CreateVpcConnector

Create an AWS App Runner VPC connector resource. App Runner requires this resource when you want to associate your App Runner service to a custom Amazon Virtual Private Cloud (Amazon VPC).

Request Syntax

{ "SecurityGroups": [ "string" ], "Subnets": [ "string" ],

"Tags": [ {

} ],

"VpcConnectorName": "string"

}

Request Parameters

SecurityGroups (p. 22)

A list of IDs of security groups that App Runner should use for access to AWS resources under the speciﬁed subnets. If not speciﬁed, App Runner uses the default security group of the Amazon VPC.

The default security group allows all outbound traﬃc.

Type: Array of strings

Pattern: .*

Required: No Subnets (p. 22)

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.

Type: Array of strings

Pattern: .*

Required: Yes Tags (p. 22)

A list of metadata items that you can associate with your VPC connector resource. A tag is a key- value pair.

(31)

Response Syntax

VpcConnectorName (p. 22) A name for the VPC connector.

Type: String

Required: Yes

Response Syntax

{ "VpcConnector": { "CreatedAt": number, "DeletedAt": number,

"SecurityGroups": [ "string" ], "Status": "string",

"Subnets": [ "string" ], "VpcConnectorArn": "string", "VpcConnectorName": "string", "VpcConnectorRevision": number }}

Response Elements

VpcConnector (p. 23)

A description of the App Runner VPC connector that's created by this request.

Type: VpcConnector (p. 139) object

Errors

(32)

Examples

ServiceQuotaExceededException

Examples

Create a VPC connector

This example illustrates how to create a VPC connector.

Sample Request

$ aws apprunner create-vpc-connector --cli-input-json "`cat`"

{ "VpcConnectorName": "my-vpc-connector", "Subnets": ["subnet-123", "subnet-456"], "SecurityGroups": ["sg-123", "sg-456"]

}

Sample Response

{ "VpcConnector": {

"VpcConnectorArn": "arn:aws:apprunner:us-east-1:123456789012:vpcconnector/my-vpcconnector/1/3f2eb10e2c494674952026f646844e3d",

"VpcConnectorName": "my-vpc-connector", "VpcConnectorRevision": 1,

"Subnets": ["subnet-123", "subnet-456"], "SecurityGroups": ["sg-123", "sg-456"], "Status": "ACTIVE",

"CreatedAt": "2021-08-18T23:36:45.374Z"

}}

DeleteAutoScalingConﬁguration

Delete an AWS App Runner automatic scaling 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.

Request Syntax

{

"AutoScalingConfigurationArn": "string"

}

Request Parameters

AutoScalingConﬁgurationArn (p. 25)

The Amazon Resource Name (ARN) of the App Runner auto scaling conﬁguration that you want to delete.

The ARN can be a full auto scaling conﬁguration ARN, or a partial ARN ending with either .../name or .../name/revision . If a revision isn't speciﬁed, the latest active revision is deleted.

Type: String

\/|-){1,1011}

Required: Yes

Response Syntax

{

"AutoScalingConfigurationArn": "string", "AutoScalingConfigurationName": "string", "AutoScalingConfigurationRevision": number, "CreatedAt": number,

"DeletedAt": number, "Latest": boolean,

"MaxConcurrency": number, "MaxSize": number, "MinSize": number, "Status": "string"

} }

Response Elements

(34)

Errors

AutoScalingConﬁguration (p. 25)

A description of the App Runner auto scaling conﬁguration that this request just deleted.

Type: AutoScalingConﬁguration (p. 106) object

Errors

HTTP Status Code: 400 ResourceNotFoundException

A resource doesn't exist for the speciﬁed Amazon Resource Name (ARN) in your AWS account.

Examples

Delete the latest active revision of an auto scaling conﬁguration

This example illustrates how to delete the latest active revision of an App Runner auto scaling conﬁguration. To delete the latest active revision, specify an Amazon Resource Name (ARN) that ends with the conﬁguration name, without the revision component.

In the example, two revisions exist before this action. Therefore, revision 2 (the latest) is deleted.

However, it now shows "Latest": false, because, after being deleted, it isn't the latest active revision anymore.

Sample Request

$ aws apprunner delete-auto-scaling-configuration --cli-input-json "`cat`"

{ "AutoScalingConfigurationArn": "arn:aws:apprunner:us-

east-1:123456789012:autoscalingconfiguration/high-availability"

}

Sample Response

{ "AutoScalingConfiguration": {

"AutoScalingConfigurationArn": "arn:aws:apprunner:us-

east-1:123456789012:autoscalingconfiguration/high-availability/2/

e76562f50d78042e819fead0f59672e6",

(35)

See Also

"CreatedAt": "2021-02-25T17:42:59Z", "DeletedAt": "2021-03-02T08:07:06Z", "Latest": false,

"MinSize": 5 }

}

Delete a speciﬁc revision of an auto scaling conﬁguration

This example illustrates how to delete a specific revision of an App Runner auto scaling configuration. To delete a specific revision, specify an ARN that includes the revision number.

In the example, several revisions exist before this action. The action deletes revision 1.

Sample Request

$ aws apprunner delete-auto-scaling-configuration --cli-input-json "`cat`"

{ "AutoScalingConfigurationArn": "arn:aws:apprunner:us-

east-1:123456789012:autoscalingconfiguration/high-availability/1"

}

Sample Response

{

"AutoScalingConfigurationArn": "arn:aws:apprunner:us- east-1:123456789012:autoscalingconfiguration/high-

availability/1/2f50e7656d7819fead0f59672e68042e",

"CreatedAt": "2021-02-25T17:42:59Z", "DeletedAt": "2021-03-02T08:07:06Z", "Latest": false,

"MinSize": 5 }

}

DeleteConnection

Delete an AWS App Runner connection. You must ﬁrst ensure that there are no running App Runner services that use this connection. If there are any, the DeleteConnection action fails.

Request Syntax

{

"ConnectionArn": "string"

}

Request Parameters

ConnectionArn (p. 29)

The Amazon Resource Name (ARN) of the App Runner connection that you want to delete.

Type: String

\/|-){1,1011}

Required: Yes

Response Syntax

{

"Connection": {

"ConnectionArn": "string", "ConnectionName": "string", "CreatedAt": number, "ProviderType": "string", "Status": "string"

}}

Response Elements

Connection (p. 29)

A description of the App Runner connection that this request just deleted.

Type: Connection (p. 116) object

(38)

Errors

Examples

Delete a connection

This example illustrates deleting an App Runner connection. The connection status after a successful call is DELETED. This is because the connection is no longer available.

Sample Request

$ aws apprunner delete-connection --cli-input-json "`cat`"

{ "ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github- connection"

}

Sample Response

{

"Connection": {

"ConnectionArn": "arn:aws:apprunner:us-east-1:123456789012:connection/my-github- connection",

"ConnectionName": "my-github-connection", "Status": "DELETED",

"CreatedAt": "2020-11-03T00:32:51Z", "ProviderType": "GITHUB"

}}

DeleteService

Delete an AWS App Runner service.

This is an asynchronous operation. On a successful call, you can use the returned OperationId and the ListOperations (p. 67) call to track the operation's progress.

Request Syntax

{ "ServiceArn": "string"

}

Request Parameters

ServiceArn (p. 32)

The Amazon Resource Name (ARN) of the App Runner service that you want to delete.

Type: String

\/|-){1,1011}

Required: Yes

Response Syntax

{ "OperationId": "string", "Service": {

"AutoScalingConfigurationSummary": { "AutoScalingConfigurationArn": "string", "AutoScalingConfigurationName": "string", "AutoScalingConfigurationRevision": number },

"CreatedAt": number, "DeletedAt": number,

"EncryptionConfiguration": { "KmsKey": "string"

},

"InstanceRoleArn": "string",

(41)

Response Elements

"Memory": "string"

},

} },

"ServiceArn": "string", "ServiceId": "string", "ServiceName": "string", "ServiceUrl": "string", "SourceConfiguration": {

},

} },

"ImageRepository": { "ImageConfiguration": { "Port": "string",

},

} },

"Status": "string", "UpdatedAt": number }}

Response Elements

OperationId (p. 32)

The unique ID of the asynchronous operation that this request started. You can use it combined with the ListOperations (p. 67) call to track the operation's progress.

(42)

Errors

Type: String

Length Constraints: Fixed length of 36.

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}

Service (p. 32)

A description of the App Runner service that this request just deleted.

Type: Service (p. 131) object

Errors

HTTP Status Code: 400 InvalidStateException

You can't perform this action when the resource is in its current state.

Examples

Delete a service

This example illustrates how to delete an App Runner service.

Sample Request

$ aws apprunner delete-service --cli-input-json "`cat`"

{ "ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python- app/8fe1e10304f84fd2b0df550fe98a71fa"

}

Sample Response

{

(43)

See Also

"OperationId": "17fe9f55-7e91-4097-b243-fcabbb69a4cf", "Service": {

"ServiceArn": "arn:aws:apprunner:us-east-1:123456789012:service/python- app/8fe1e10304f84fd2b0df550fe98a71fa",

"ServiceId": "8fe1e10304f84fd2b0df550fe98a71fa", "ServiceName": "python-app",

},

"CodeConfigurationValues": {

"BuildCommand": "[pip install -r requirements.txt]", "Port": "8080",

"Runtime": "PYTHON_3",

"NAME": "Jane"

} ],

"StartCommand": "python server.py"

},

"ConfigurationSource": "Api"

},

"RepositoryUrl": "https://github.com/my-account/python-hello", "SourceCodeVersion": {

"Type": "BRANCH", "Value": "main"

} } },

},

} } }}

DeleteVpcConnector

Delete an AWS App Runner VPC connector resource. You can't delete a connector that's used by one or more App Runner services.

Request Syntax

{ "VpcConnectorArn": "string"

}

Request Parameters

VpcConnectorArn (p. 37)

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.

Type: String

\/|-){1,1011}

Required: Yes

Response Syntax

{ "VpcConnector": { "CreatedAt": number, "DeletedAt": number,

"SecurityGroups": [ "string" ], "Status": "string",

"Subnets": [ "string" ], "VpcConnectorArn": "string", "VpcConnectorName": "string", "VpcConnectorRevision": number }}

Response Elements

(46)

Errors

VpcConnector (p. 37)

A description of the App Runner VPC connector that this request just deleted.

Type: VpcConnector (p. 139) object

Errors

Examples

Delete a VPC connector

This example illustrates how to delete an App Runner VPC connector.

Sample Request

$ aws apprunner delete-vpc-connector --cli-input-json "`cat`"

{ "VpcConnectorArn": "arn:aws:apprunner:us-east-1:123456789012:vpcconnector/my-vpcconnector/1/3f2eb10e2c494674952026f646844e3d"

}

Sample Response

{ "VpcConnector": {

"VpcConnectorArn": "arn:aws:apprunner:us-east-1:123456789012:vpcconnector/my-vpcconnector/1/3f2eb10e2c494674952026f646844e3d",

"VpcConnectorName": "my-vpc-connector", "VpcConnectorRevision": 1,

"Subnets": ["subnet-123", "subnet-456"], "SecurityGroups": ["sg-123", "sg-456"], "Status": "INACTIVE",

"CreatedAt": "2021-08-18T23:36:45.374Z", "DeletedAt": "2021-09-23T11:42:17.545Z"

}

(47)

See Also

}

AWS App Runner

AWS App Runner

API Reference

API Version 2020-05-15

AWS App Runner: API Reference

Table of Contents

Welcome

Actions

AssociateCustomDomain

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Associate a domain name and the www subdomain with a service

Sample Request

Sample Response

See Also

CreateAutoScalingConﬁguration

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Create a high availability auto scaling conﬁguration

Sample Request

Sample Response

See Also

CreateConnection

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Create a GitHub connection

Sample Request

Sample Response

See Also

CreateService

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Create a source code repository service

Sample Request

Sample Response

Create a source image repository service

Sample Request

Sample Response

See Also

CreateVpcConnector

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Create a VPC connector

Sample Request

Sample Response

See Also

DeleteAutoScalingConﬁguration

Request Syntax

Request Parameters

Response Syntax

Response Elements

Errors

Examples

Delete the latest active revision of an auto scaling conﬁguration

Sample Request

Sample Response

Delete a speciﬁc revision of an auto scaling conﬁguration

Sample Request

Sample Response

See Also