Package software.amazon.awscdk.services.apprunner

Interface CfnServiceProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnServiceProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.118.0 (build 02eec31)",
           date="2025-11-04T09:27:34.360Z")
@Stability(Stable)
public interface CfnServiceProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnService.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.apprunner.*;
 CfnServiceProps cfnServiceProps = CfnServiceProps.builder()
         .sourceConfiguration(SourceConfigurationProperty.builder()
                 .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                         .accessRoleArn("accessRoleArn")
                         .connectionArn("connectionArn")
                         .build())
                 .autoDeploymentsEnabled(false)
                 .codeRepository(CodeRepositoryProperty.builder()
                         .repositoryUrl("repositoryUrl")
                         .sourceCodeVersion(SourceCodeVersionProperty.builder()
                                 .type("type")
                                 .value("value")
                                 .build())
                         // the properties below are optional
                         .codeConfiguration(CodeConfigurationProperty.builder()
                                 .configurationSource("configurationSource")
                                 // the properties below are optional
                                 .codeConfigurationValues(CodeConfigurationValuesProperty.builder()
                                         .runtime("runtime")
                                         // the properties below are optional
                                         .buildCommand("buildCommand")
                                         .port("port")
                                         .runtimeEnvironmentSecrets(List.of(KeyValuePairProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .runtimeEnvironmentVariables(List.of(KeyValuePairProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .startCommand("startCommand")
                                         .build())
                                 .build())
                         .sourceDirectory("sourceDirectory")
                         .build())
                 .imageRepository(ImageRepositoryProperty.builder()
                         .imageIdentifier("imageIdentifier")
                         .imageRepositoryType("imageRepositoryType")
                         // the properties below are optional
                         .imageConfiguration(ImageConfigurationProperty.builder()
                                 .port("port")
                                 .runtimeEnvironmentSecrets(List.of(KeyValuePairProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .runtimeEnvironmentVariables(List.of(KeyValuePairProperty.builder()
                                         .name("name")
                                         .value("value")
                                         .build()))
                                 .startCommand("startCommand")
                                 .build())
                         .build())
                 .build())
         // the properties below are optional
         .autoScalingConfigurationArn("autoScalingConfigurationArn")
         .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                 .kmsKey("kmsKey")
                 .build())
         .healthCheckConfiguration(HealthCheckConfigurationProperty.builder()
                 .healthyThreshold(123)
                 .interval(123)
                 .path("path")
                 .protocol("protocol")
                 .timeout(123)
                 .unhealthyThreshold(123)
                 .build())
         .instanceConfiguration(InstanceConfigurationProperty.builder()
                 .cpu("cpu")
                 .instanceRoleArn("instanceRoleArn")
                 .memory("memory")
                 .build())
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .egressConfiguration(EgressConfigurationProperty.builder()
                         .egressType("egressType")
                         // the properties below are optional
                         .vpcConnectorArn("vpcConnectorArn")
                         .build())
                 .ingressConfiguration(IngressConfigurationProperty.builder()
                         .isPubliclyAccessible(false)
                         .build())
                 .ipAddressType("ipAddressType")
                 .build())
         .observabilityConfiguration(ServiceObservabilityConfigurationProperty.builder()
                 .observabilityEnabled(false)
                 // the properties below are optional
                 .observabilityConfigurationArn("observabilityConfigurationArn")
                 .build())
         .serviceName("serviceName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnServiceProps.Builder	builder()
default String	getAutoScalingConfigurationArn()	The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
default Object	getEncryptionConfiguration()	An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
default Object	getHealthCheckConfiguration()	The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
default Object	getInstanceConfiguration()	The runtime configuration of instances (scaling units) of your service.
default Object	getNetworkConfiguration()	Configuration settings related to network traffic of the web application that the App Runner service runs.
default Object	getObservabilityConfiguration()	The observability configuration of your service.
default String	getServiceName()	A name for the App Runner service.
Object	getSourceConfiguration()	The source to deploy to the App Runner service.
default List<CfnTag>	getTags()	An optional list of metadata items that you can associate with the App Runner service resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getSourceConfiguration

@Stability(Stable)
@NotNull
Object getSourceConfiguration()

The source to deploy to the App Runner service.

It can be a code or an image repository.

Returns union: either IResolvable or CfnService.SourceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-sourceconfiguration

getAutoScalingConfigurationArn

@Stability(Stable)
@Nullable
default String getAutoScalingConfigurationArn()

The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.

If not provided, App Runner associates the latest revision of a default auto scaling configuration.

Specify an ARN with a name and a revision number to associate that revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability/3

Specify just the name to associate the latest revision. For example: arn:aws:apprunner:us-east-1:123456789012:autoscalingconfiguration/high-availability

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-autoscalingconfigurationarn

getEncryptionConfiguration

@Stability(Stable)
@Nullable
default Object getEncryptionConfiguration()

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 .

Returns union: either IResolvable or CfnService.EncryptionConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-encryptionconfiguration

getHealthCheckConfiguration

@Stability(Stable)
@Nullable
default Object getHealthCheckConfiguration()

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

Returns union: either IResolvable or CfnService.HealthCheckConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-healthcheckconfiguration

getInstanceConfiguration

@Stability(Stable)
@Nullable
default Object getInstanceConfiguration()

The runtime configuration of instances (scaling units) of your service.

Returns union: either IResolvable or CfnService.InstanceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-instanceconfiguration

getNetworkConfiguration

@Stability(Stable)
@Nullable
default Object getNetworkConfiguration()

Configuration settings related to network traffic of the web application that the App Runner service runs.

Returns union: either IResolvable or CfnService.NetworkConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-networkconfiguration

getObservabilityConfiguration

@Stability(Stable)
@Nullable
default Object getObservabilityConfiguration()

The observability configuration of your service.

Returns union: either IResolvable or CfnService.ServiceObservabilityConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-observabilityconfiguration

getServiceName

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

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 .

If you don't specify a name, AWS CloudFormation generates a name for your service.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-servicename

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An optional list of metadata items that you can associate with the App Runner service resource.

A tag is a key-value pair.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-apprunner-service.html#cfn-apprunner-service-tags

builder

@Stability(Stable)
static CfnServiceProps.Builder builder()

Returns:

a CfnServiceProps.Builder of CfnServiceProps