@aws-cdk_aws-apprunner-alpha.ServiceProps

interface ServiceProps ๐Ÿ”น

LanguageType name
.NETAmazon.CDK.AWS.AppRunner.Alpha.ServiceProps
Gogithub.com/aws/aws-cdk-go/awscdkapprunneralpha/v2#ServiceProps
Javasoftware.amazon.awscdk.services.apprunner.alpha.ServiceProps
Pythonaws_cdk.aws_apprunner_alpha.ServiceProps
TypeScript (source)@aws-cdk/aws-apprunner-alpha ยป ServiceProps

Properties of the AppRunner Service.

Example

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

Properties

NameTypeDescription
source๐Ÿ”นSourceThe source of the repository for the service.
accessRole?๐Ÿ”นIRoleThe IAM role that grants the App Runner service access to a source repository.
autoDeploymentsEnabled?๐Ÿ”นbooleanSpecifies whether to enable continuous integration from the source repository.
cpu?๐Ÿ”นCpuThe number of CPU units reserved for each instance of your App Runner service.
instanceRole?๐Ÿ”นIRoleThe IAM role that provides permissions to your App Runner service.
memory?๐Ÿ”นMemoryThe amount of memory reserved for each instance of your App Runner service.
serviceName?๐Ÿ”นstringName of the service.
vpcConnector?๐Ÿ”นIVpcConnectorSettings for an App Runner VPC connector to associate with the service.

source๐Ÿ”น

Type: Source

The source of the repository for the service.


accessRole?๐Ÿ”น

Type: IRole (optional, default: generate a new access role.)

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).

The role must be assumable by the 'build.apprunner.amazonaws.com' service principal.

See also: https://docs.aws.amazon.com/apprunner/latest/dg/security_iam_service-with-iam.html#security_iam_service-with-iam-roles-service.access


autoDeploymentsEnabled?๐Ÿ”น

Type: boolean (optional, default: no value will be passed.)

Specifies whether to enable continuous integration from the source repository.

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. By default, App Runner sets to false for a source image that uses an ECR Public repository or an ECR repository that's in an AWS 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).


cpu?๐Ÿ”น

Type: Cpu (optional, default: Cpu.ONE_VCPU)

The number of CPU units reserved for each instance of your App Runner service.


instanceRole?๐Ÿ”น

Type: IRole (optional, default: no instance role attached.)

The IAM role that provides permissions to your App Runner service.

These are permissions that your code needs when it calls any AWS APIs.

The role must be assumable by the 'tasks.apprunner.amazonaws.com' service principal.

See also: https://docs.aws.amazon.com/apprunner/latest/dg/security_iam_service-with-iam.html#security_iam_service-with-iam-roles-service.instance


memory?๐Ÿ”น

Type: Memory (optional, default: Memory.TWO_GB)

The amount of memory reserved for each instance of your App Runner service.


serviceName?๐Ÿ”น

Type: string (optional, default: auto-generated if undefined.)

Name of the service.


vpcConnector?๐Ÿ”น

Type: IVpcConnector (optional, default: no VPC connector, uses the DEFAULT egress type instead)

Settings for an App Runner VPC connector to associate with the service.