software.amazon.awscdk.services.apprunner

Class CfnService.Builder

java.lang.Object

software.amazon.awscdk.services.apprunner.CfnService.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnService>

Enclosing class:

CfnService

@Stability(value=Stable)
public static final class CfnService.Builder
extends Object
implements software.amazon.jsii.Builder<CfnService>

A fluent builder for CfnService.

Method Summary

Modifier and Type	Method and Description
CfnService.Builder	autoScalingConfigurationArn(String autoScalingConfigurationArn) The Amazon Resource Name (ARN) of an App Runner automatic scaling configuration resource that you want to associate with your service.
CfnService	build()
static CfnService.Builder	create(software.constructs.Construct scope, String id)
CfnService.Builder	encryptionConfiguration(CfnService.EncryptionConfigurationProperty encryptionConfiguration) An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
CfnService.Builder	encryptionConfiguration(IResolvable encryptionConfiguration) An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs.
CfnService.Builder	healthCheckConfiguration(CfnService.HealthCheckConfigurationProperty healthCheckConfiguration) The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
CfnService.Builder	healthCheckConfiguration(IResolvable healthCheckConfiguration) The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service.
CfnService.Builder	instanceConfiguration(CfnService.InstanceConfigurationProperty instanceConfiguration) The runtime configuration of instances (scaling units) of your service.
CfnService.Builder	instanceConfiguration(IResolvable instanceConfiguration) The runtime configuration of instances (scaling units) of your service.
CfnService.Builder	networkConfiguration(CfnService.NetworkConfigurationProperty networkConfiguration) Configuration settings related to network traffic of the web application that the App Runner service runs.
CfnService.Builder	networkConfiguration(IResolvable networkConfiguration) Configuration settings related to network traffic of the web application that the App Runner service runs.
CfnService.Builder	observabilityConfiguration(CfnService.ServiceObservabilityConfigurationProperty observabilityConfiguration) The observability configuration of your service.
CfnService.Builder	observabilityConfiguration(IResolvable observabilityConfiguration) The observability configuration of your service.
CfnService.Builder	serviceName(String serviceName) A name for the App Runner service.
CfnService.Builder	sourceConfiguration(CfnService.SourceConfigurationProperty sourceConfiguration) The source to deploy to the App Runner service.
CfnService.Builder	sourceConfiguration(IResolvable sourceConfiguration) The source to deploy to the App Runner service.
CfnService.Builder	tags(List<? extends CfnTag> tags) An optional list of metadata items that you can associate with the App Runner service resource.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnService.Builder create(software.constructs.Construct scope,
                                                                 String id)

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnService.AuthenticationConfigurationProperty.Builder.

sourceConfiguration

@Stability(value=Stable)
public CfnService.Builder sourceConfiguration(CfnService.SourceConfigurationProperty sourceConfiguration)

The source to deploy to the App Runner service.

It can be a code or an image repository.

Parameters:

sourceConfiguration - The source to deploy to the App Runner service. This parameter is required.

Returns:

this

sourceConfiguration

@Stability(value=Stable)
public CfnService.Builder sourceConfiguration(IResolvable sourceConfiguration)

The source to deploy to the App Runner service.

It can be a code or an image repository.

Parameters:

sourceConfiguration - The source to deploy to the App Runner service. This parameter is required.

Returns:

this

autoScalingConfigurationArn

@Stability(value=Stable)
public CfnService.Builder autoScalingConfigurationArn(String autoScalingConfigurationArn)

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

Parameters:

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

Returns:

this

encryptionConfiguration

@Stability(value=Stable)
public CfnService.Builder encryptionConfiguration(CfnService.EncryptionConfigurationProperty encryptionConfiguration)

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 .

Parameters:

encryptionConfiguration - An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. This parameter is required.

Returns:

this

encryptionConfiguration

@Stability(value=Stable)
public CfnService.Builder encryptionConfiguration(IResolvable encryptionConfiguration)

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 .

Parameters:

encryptionConfiguration - An optional custom encryption key that App Runner uses to encrypt the copy of your source repository that it maintains and your service logs. This parameter is required.

Returns:

this

healthCheckConfiguration

@Stability(value=Stable)
public CfnService.Builder healthCheckConfiguration(CfnService.HealthCheckConfigurationProperty healthCheckConfiguration)

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

Parameters:

healthCheckConfiguration - The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service. This parameter is required.

Returns:

this

healthCheckConfiguration

@Stability(value=Stable)
public CfnService.Builder healthCheckConfiguration(IResolvable healthCheckConfiguration)

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

Parameters:

healthCheckConfiguration - The settings for the health check that AWS App Runner performs to monitor the health of the App Runner service. This parameter is required.

Returns:

this

instanceConfiguration

@Stability(value=Stable)
public CfnService.Builder instanceConfiguration(CfnService.InstanceConfigurationProperty instanceConfiguration)

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

Parameters:

instanceConfiguration - The runtime configuration of instances (scaling units) of your service. This parameter is required.

Returns:

this

instanceConfiguration

@Stability(value=Stable)
public CfnService.Builder instanceConfiguration(IResolvable instanceConfiguration)

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

Parameters:

instanceConfiguration - The runtime configuration of instances (scaling units) of your service. This parameter is required.

Returns:

this

networkConfiguration

@Stability(value=Stable)
public CfnService.Builder networkConfiguration(CfnService.NetworkConfigurationProperty networkConfiguration)

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

Parameters:

networkConfiguration - Configuration settings related to network traffic of the web application that the App Runner service runs. This parameter is required.

Returns:

this

networkConfiguration

@Stability(value=Stable)
public CfnService.Builder networkConfiguration(IResolvable networkConfiguration)

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

Parameters:

networkConfiguration - Configuration settings related to network traffic of the web application that the App Runner service runs. This parameter is required.

Returns:

this

observabilityConfiguration

@Stability(value=Stable)
public CfnService.Builder observabilityConfiguration(CfnService.ServiceObservabilityConfigurationProperty observabilityConfiguration)

The observability configuration of your service.

Parameters:

observabilityConfiguration - The observability configuration of your service. This parameter is required.

Returns:

this

observabilityConfiguration

@Stability(value=Stable)
public CfnService.Builder observabilityConfiguration(IResolvable observabilityConfiguration)

The observability configuration of your service.

Parameters:

observabilityConfiguration - The observability configuration of your service. This parameter is required.

Returns:

this

serviceName

@Stability(value=Stable)
public CfnService.Builder serviceName(String serviceName)

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.

Parameters:

serviceName - A name for the App Runner service. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnService.Builder tags(List<? extends CfnTag> tags)

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

A tag is a key-value pair.

Parameters:

tags - An optional list of metadata items that you can associate with the App Runner service resource. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public CfnService build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnService>