Package software.amazon.awscdk.services.apprunner

Interface ServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:40.060Z")
@Stability(Experimental)
public interface ServiceProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Properties of the AppRunner Service.

Example:

 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ServiceProps.Builder	A builder for ServiceProps
static final class	ServiceProps.Jsii$Proxy	An implementation for ServiceProps

Method Summary

Modifier and Type	Method	Description
static ServiceProps.Builder	builder()
default IRole	getAccessRole()	(experimental) The IAM role that grants the App Runner service access to a source repository.
default Cpu	getCpu()	(experimental) The number of CPU units reserved for each instance of your App Runner service.
default IRole	getInstanceRole()	(experimental) The IAM role that provides permissions to your App Runner service.
default Memory	getMemory()	(experimental) The amount of memory reserved for each instance of your App Runner service.
default String	getServiceName()	(experimental) Name of the service.
Source	getSource()	(experimental) The source of the repository for the service.
default IVpcConnector	getVpcConnector()	(experimental) Settings for an App Runner VPC connector to associate with the service.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSource

@Stability(Experimental)
@NotNull
Source getSource()

(experimental) The source of the repository for the service.

getAccessRole

@Stability(Experimental)
@Nullable
default IRole getAccessRole()

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

Default: - generate a new access role.

See Also:

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

getCpu

@Stability(Experimental)
@Nullable
default Cpu getCpu()

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

Default: Cpu.ONE_VCPU

getInstanceRole

@Stability(Experimental)
@Nullable
default IRole getInstanceRole()

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

Default: - no instance role attached.

See Also:

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

getMemory

@Stability(Experimental)
@Nullable
default Memory getMemory()

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

Default: Memory.TWO_GB

getServiceName

@Stability(Experimental)
@Nullable
default String getServiceName()

(experimental) Name of the service.

Default: - auto-generated if undefined.

getVpcConnector

@Stability(Experimental)
@Nullable
default IVpcConnector getVpcConnector()

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

Default: - no VPC connector, uses the DEFAULT egress type instead

builder

@Stability(Experimental)
static ServiceProps.Builder builder()

Returns:

a ServiceProps.Builder of ServiceProps