Skip navigation links

Package software.amazon.awscdk.services.apprunner

AWS::AppRunner Construct Library

See: Description

Package software.amazon.awscdk.services.apprunner Description

AWS::AppRunner Construct Library

---

cfn-resources: Stable

All classes with the Cfn prefix in this module (CFN Resources) are always stable and safe to use.

cdk-constructs: Experimental

The APIs of higher level constructs in this module are experimental and under active development. They are subject to non-backward compatible changes or removal in any future version. These are not subject to the Semantic Versioning model and breaking changes will be announced in the release notes. This means that while you may use them, you may need to update your source code when upgrading to a newer version of this package.

This module is part of the AWS Cloud Development Kit project. 

 import software.amazon.awscdk.services.apprunner.*;

Introduction

AWS App Runner is a fully managed service that makes it easy for developers to quickly deploy containerized web applications and APIs, at scale and with no prior infrastructure experience required. Start with your source code or a container image. App Runner automatically builds and deploys the web application and load balances traffic with encryption. App Runner also scales up or down automatically to meet your traffic needs. With App Runner, rather than thinking about servers or scaling, you have more time to focus on your applications.

Service

The Service construct allows you to create AWS App Runner services with ECR Public, ECR or Github with the source property in the following scenarios:

ECR Public

To create a Service with ECR Public: 

 Service.Builder.create(this, "Service")
         .source(Source.fromEcrPublic(EcrPublicProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                 .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                 .build()))
         .build();

ECR

To create a Service from an existing ECR repository: 

 import software.amazon.awscdk.services.ecr.*;
 
 
 Service.Builder.create(this, "Service")
         .source(Source.fromEcr(EcrProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(80).build())
                 .repository(Repository.fromRepositoryName(this, "NginxRepository", "nginx"))
                 .tagOrDigest("latest")
                 .build()))
         .build();

To create a Service from local docker image asset directory built and pushed to Amazon ECR: 

 import software.amazon.awscdk.services.ecr.assets.*;
 
 
 DockerImageAsset imageAsset = DockerImageAsset.Builder.create(this, "ImageAssets")
         .directory(join(__dirname, "./docker.assets"))
         .build();
 Service.Builder.create(this, "Service")
         .source(Source.fromAsset(AssetProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                 .asset(imageAsset)
                 .build()))
         .build();

GitHub

To create a Service from the GitHub repository, you need to specify an existing App Runner Connection.

See Managing App Runner connections for more details. 

 Service.Builder.create(this, "Service")
         .source(Source.fromGitHub(GithubRepositoryProps.builder()
                 .repositoryUrl("https://github.com/aws-containers/hello-app-runner")
                 .branch("main")
                 .configurationSource(ConfigurationSourceType.REPOSITORY)
                 .connection(GitHubConnection.fromConnectionArn("CONNECTION_ARN"))
                 .build()))
         .build();

Use codeConfigurationValues to override configuration values with the API configuration source type. 

 Service.Builder.create(this, "Service")
         .source(Source.fromGitHub(GithubRepositoryProps.builder()
                 .repositoryUrl("https://github.com/aws-containers/hello-app-runner")
                 .branch("main")
                 .configurationSource(ConfigurationSourceType.API)
                 .codeConfigurationValues(CodeConfigurationValues.builder()
                         .runtime(Runtime.PYTHON_3)
                         .port("8000")
                         .startCommand("python app.py")
                         .buildCommand("yum install -y pycairo && pip install -r requirements.txt")
                         .build())
                 .connection(GitHubConnection.fromConnectionArn("CONNECTION_ARN"))
                 .build()))
         .build();

IAM Roles

You are allowed to define instanceRole and accessRole for the Service.

instanceRole - The IAM role that provides permissions to your App Runner service. These are permissions that your code needs when it calls any AWS APIs.

accessRole - 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). If not defined, a new access role will be generated when required.

See App Runner IAM Roles for more details.

VPC Connector

To associate an App Runner service with a custom VPC, define vpcConnector for the service. 

 import software.amazon.awscdk.services.ec2.*;
 
 
 Vpc vpc = Vpc.Builder.create(this, "Vpc")
         .cidr("10.0.0.0/16")
         .build();
 
 VpcConnector vpcConnector = VpcConnector.Builder.create(this, "VpcConnector")
         .vpc(vpc)
         .vpcSubnets(vpc.selectSubnets(SubnetSelection.builder().subnetType(SubnetType.PUBLIC).build()))
         .vpcConnectorName("MyVpcConnector")
         .build();
 
 Service.Builder.create(this, "Service")
         .source(Source.fromEcrPublic(EcrPublicProps.builder()
                 .imageConfiguration(ImageConfiguration.builder().port(8000).build())
                 .imageIdentifier("public.ecr.aws/aws-containers/hello-app-runner:latest")
                 .build()))
         .vpcConnector(vpcConnector)
         .build();
Skip navigation links