Package software.amazon.awscdk.cfnpropertymixins.services.apprunner

Class CfnServicePropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.apprunner.CfnServicePropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:19:55.874Z")
@Stability(Stable)
public class CfnServicePropsMixin
extends Mixin
implements software.constructs.IMixin

Specify an AWS App Runner service by using the AWS::AppRunner::Service resource in an AWS CloudFormation template.

The AWS::AppRunner::Service resource is an AWS App Runner resource type that specifies an App Runner service.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.apprunner.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnServicePropsMixin cfnServicePropsMixin = CfnServicePropsMixin.Builder.create(CfnServiceMixinProps.builder()
         .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")
                         .vpcConnectorArn("vpcConnectorArn")
                         .build())
                 .ingressConfiguration(IngressConfigurationProperty.builder()
                         .isPubliclyAccessible(false)
                         .build())
                 .ipAddressType("ipAddressType")
                 .build())
         .observabilityConfiguration(ServiceObservabilityConfigurationProperty.builder()
                 .observabilityConfigurationArn("observabilityConfigurationArn")
                 .observabilityEnabled(false)
                 .build())
         .serviceName("serviceName")
         .sourceConfiguration(SourceConfigurationProperty.builder()
                 .authenticationConfiguration(AuthenticationConfigurationProperty.builder()
                         .accessRoleArn("accessRoleArn")
                         .connectionArn("connectionArn")
                         .build())
                 .autoDeploymentsEnabled(false)
                 .codeRepository(CodeRepositoryProperty.builder()
                         .codeConfiguration(CodeConfigurationProperty.builder()
                                 .codeConfigurationValues(CodeConfigurationValuesProperty.builder()
                                         .buildCommand("buildCommand")
                                         .port("port")
                                         .runtime("runtime")
                                         .runtimeEnvironmentSecrets(List.of(KeyValuePairProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .runtimeEnvironmentVariables(List.of(KeyValuePairProperty.builder()
                                                 .name("name")
                                                 .value("value")
                                                 .build()))
                                         .startCommand("startCommand")
                                         .build())
                                 .configurationSource("configurationSource")
                                 .build())
                         .repositoryUrl("repositoryUrl")
                         .sourceCodeVersion(SourceCodeVersionProperty.builder()
                                 .type("type")
                                 .value("value")
                                 .build())
                         .sourceDirectory("sourceDirectory")
                         .build())
                 .imageRepository(ImageRepositoryProperty.builder()
                         .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())
                         .imageIdentifier("imageIdentifier")
                         .imageRepositoryType("imageRepositoryType")
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnServicePropsMixin.AuthenticationConfigurationProperty	Describes resources needed to authenticate access to some source repositories.
static final class	CfnServicePropsMixin.Builder	A fluent builder for CfnServicePropsMixin.
static interface	CfnServicePropsMixin.CodeConfigurationProperty	Describes the configuration that AWS App Runner uses to build and run an App Runner service from a source code repository.
static interface	CfnServicePropsMixin.CodeConfigurationValuesProperty	Describes the basic configuration needed for building and running an AWS App Runner service.
static interface	CfnServicePropsMixin.CodeRepositoryProperty	Describes a source code repository.
static interface	CfnServicePropsMixin.EgressConfigurationProperty	Describes configuration settings related to outbound network traffic of an AWS App Runner service.
static interface	CfnServicePropsMixin.EncryptionConfigurationProperty	Describes a custom encryption key that AWS App Runner uses to encrypt copies of the source repository and service logs.
static interface	CfnServicePropsMixin.HealthCheckConfigurationProperty	Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.
static interface	CfnServicePropsMixin.ImageConfigurationProperty	Describes the configuration that AWS App Runner uses to run an App Runner service using an image pulled from a source image repository.
static interface	CfnServicePropsMixin.ImageRepositoryProperty	Describes a source image repository.
static interface	CfnServicePropsMixin.IngressConfigurationProperty	Network configuration settings for inbound network traffic.
static interface	CfnServicePropsMixin.InstanceConfigurationProperty	Describes the runtime configuration of an AWS App Runner service instance (scaling unit).
static interface	CfnServicePropsMixin.KeyValuePairProperty	Describes a key-value pair, which is a string-to-string mapping.
static interface	CfnServicePropsMixin.NetworkConfigurationProperty	Describes configuration settings related to network traffic of an AWS App Runner service.
static interface	CfnServicePropsMixin.ServiceObservabilityConfigurationProperty	Describes the observability configuration of an AWS App Runner service.
static interface	CfnServicePropsMixin.SourceCodeVersionProperty	Identifies a version of code that AWS App Runner refers to within a source code repository.
static interface	CfnServicePropsMixin.SourceConfigurationProperty	Describes the source deployed to an AWS App Runner service.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnServicePropsMixin(CfnServiceMixinProps props)	Create a mixin to apply properties to AWS::AppRunner::Service.
	CfnServicePropsMixin(CfnServiceMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::AppRunner::Service.
protected	CfnServicePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnServicePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnServiceMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnServicePropsMixin

protected CfnServicePropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnServicePropsMixin

protected CfnServicePropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnServicePropsMixin

@Stability(Stable)
public CfnServicePropsMixin(@NotNull
 CfnServiceMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::AppRunner::Service.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnServicePropsMixin

@Stability(Stable)
public CfnServicePropsMixin(@NotNull
 CfnServiceMixinProps props)

Create a mixin to apply properties to AWS::AppRunner::Service.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnServiceMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()