Interface | Description |
---|---|
AssetProps |
(experimental) Properties of the image repository for `Source.fromAsset()`.
|
CfnObservabilityConfiguration.TraceConfigurationProperty |
Describes the configuration of the tracing feature within an AWS App Runner observability configuration.
|
CfnObservabilityConfigurationProps |
Properties for defining a `CfnObservabilityConfiguration`.
|
CfnService.AuthenticationConfigurationProperty |
Describes resources needed to authenticate access to some source repositories.
|
CfnService.CodeConfigurationProperty |
Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository.
|
CfnService.CodeConfigurationValuesProperty |
Describes the basic configuration needed for building and running an AWS App Runner service.
|
CfnService.CodeRepositoryProperty |
Describes a source code repository.
|
CfnService.EgressConfigurationProperty |
Describes configuration settings related to outbound network traffic of an AWS App Runner service.
|
CfnService.EncryptionConfigurationProperty |
Describes a custom encryption key that AWS App Runner uses to encrypt copies of the source repository and service logs.
|
CfnService.HealthCheckConfigurationProperty |
Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.
|
CfnService.ImageConfigurationProperty |
Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.
|
CfnService.ImageRepositoryProperty |
Describes a source image repository.
|
CfnService.IngressConfigurationProperty |
Network configuration settings for inbound network traffic.
|
CfnService.InstanceConfigurationProperty |
Describes the runtime configuration of an AWS App Runner service instance (scaling unit).
|
CfnService.KeyValuePairProperty |
Describes a key-value pair, which is a string-to-string mapping.
|
CfnService.NetworkConfigurationProperty |
Describes configuration settings related to network traffic of an AWS App Runner service.
|
CfnService.ServiceObservabilityConfigurationProperty |
Describes the observability configuration of an AWS App Runner service.
|
CfnService.SourceCodeVersionProperty |
Identifies a version of code that AWS App Runner refers to within a source code repository.
|
CfnService.SourceConfigurationProperty |
Describes the source deployed to an AWS App Runner service.
|
CfnServiceProps |
Properties for defining a `CfnService`.
|
CfnVpcConnectorProps |
Properties for defining a `CfnVpcConnector`.
|
CfnVpcIngressConnection.IngressVpcConfigurationProperty |
Specifications for the customer’s VPC and related PrivateLink VPC endpoint that are used to associate with the VPC Ingress Connection resource.
|
CfnVpcIngressConnectionProps |
Properties for defining a `CfnVpcIngressConnection`.
|
CodeConfiguration |
(experimental) Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository.
|
CodeConfigurationValues |
(experimental) Describes the basic configuration needed for building and running an AWS App Runner service.
|
CodeRepositoryProps |
(experimental) Properties of the CodeRepository.
|
EcrProps |
(experimental) Properties of the image repository for `Source.fromEcr()`.
|
EcrPublicProps |
(experimental) Properties of the image repository for `Source.fromEcrPublic()`.
|
GithubRepositoryProps |
(experimental) Properties of the Github repository for `Source.fromGitHub()`.
|
ImageConfiguration |
(experimental) Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.
|
ImageRepository |
(experimental) Describes a source image repository.
|
IService |
(experimental) Represents the App Runner Service.
|
IService.Jsii$Default |
Internal default implementation for
IService . |
IVpcConnector |
(experimental) Represents the App Runner VPC Connector.
|
IVpcConnector.Jsii$Default |
Internal default implementation for
IVpcConnector . |
ServiceAttributes |
(experimental) Attributes for the App Runner Service.
|
ServiceProps |
(experimental) Properties of the AppRunner Service.
|
SourceCodeVersion |
(experimental) Identifies a version of code that AWS App Runner refers to within a source code repository.
|
SourceConfig |
(experimental) Result of binding `Source` into a `Service`.
|
VpcConnectorAttributes |
(experimental) Attributes for the App Runner VPC Connector.
|
VpcConnectorProps |
(experimental) Properties of the AppRunner VPC Connector.
|
Enum | Description |
---|---|
ConfigurationSourceType |
(experimental) The source of the App Runner configuration.
|
ImageRepositoryType |
(experimental) The image repository types.
|
---
All classes with the
Cfn
prefix in this module (CFN Resources) are always stable and safe to use.
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.*;
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.
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:
Source.fromEcr()
- To define the source repository from ECR
.Source.fromEcrPublic()
- To define the source repository from ECR Public
.Source.fromGitHub()
- To define the source repository from the Github repository
.Source.fromAsset()
- To define the source from local asset directory.
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();
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();
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();
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.
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();